home *** CD-ROM | disk | FTP | other *** search
/ Belgian Amiga Club - ADF Collection / BS1 part 26.zip / BS1 part 26 / Cando v1.6 disk 2.adf / HelpFiles / Object Control  < prev    next >
Text File  |  1992-01-31  |  6KB  |  305 lines
  1. C- DetachObject            |detachobject|
  2. C- DisableObject        |disableobject|
  3. C- EnableObject            |enableobject|
  4. C- FastFeedBack            |fastfeedback|
  5. C- GetPropPosition        |getpropposition|
  6. C- GetPropRange            |getproprange|
  7. C- GetPropVisibleRange    |getpropvisiblerange|
  8. F- IntegerFrom            |integerfrom|
  9. V- KeyPressed            |keypressed|
  10. C- MoveObject            |moveobject|
  11. F- ObjectAttached        |objectattached|
  12. V- ObjectName            |objectname|
  13. F- ObjectState            |objectstate|
  14. V- QualifiersPressed    |qualifierspressed|
  15. C- ReattachObject        |reattachobject|
  16. C- RefreshObject        |refreshobject|
  17. C- SetInteger            |setinteger|
  18. C- SetObjectState        |setobjectstate|
  19. C- SetPropPosition        |setpropposition|
  20. C- SetPropRange            |setproprange|
  21. C- SetPropVisibleRange    |setpropvisiblerange|
  22. C- SetText                |settext|
  23. F- TextFrom                |textfrom|
  24. [E]
  25.  
  26. |detachobject|
  27. WT DetachObject {ObjectName}
  28. PL Detach an object from the card.  All objects
  29. PL can be detached, but the imagery of graphic
  30. PL objects will not be erased.  See page 6-45
  31. PL in the supplement manual for a full
  32. PL description of this command.
  33. PT SEE ALSO: 
  34. BS ReAttachObject
  35. PT  and 
  36. BS ObjectAttached
  37. PT .
  38. ED
  39.  
  40. |disableobject|
  41. WT DisableObject {ObjectName}
  42. PL This will ghost a graphic object until
  43. PL the object has been enabled.  This only
  44. PL works on Buttons, Fields and Menus.
  45. PL 
  46. PT SEE ALSO: 
  47. BS EnableObject
  48. PT .
  49. ED
  50.  
  51. |enableobject|
  52. WT EnableObject {ObjectName}
  53. PL This will enable a graphic object that
  54. PL has been disabled.  This will do nothing
  55. PL if the object was not disabled.
  56. PL 
  57. PT SEE ALSO: 
  58. BS DisableObject
  59. PT .
  60. ED
  61.  
  62. |fastfeedback|
  63. WT FastFeedBack {Logical}
  64. PL Enables or disables FastFeedBack on
  65. PL mouse movements for an Object's Drag
  66. PL Script.  See page 6-60 in the yellow
  67. PL manual for a full discussion.
  68. ED
  69.  
  70. |getpropposition|
  71. WT GetPropPosition {ObjectName}, <HorizPosVarName> [,<VertPosVarName>]
  72. PL This will retrieve a proportional object's
  73. PL positional values.
  74. PL
  75. PT SEE ALSO: 
  76. BS SetPropPosition
  77. PT , 
  78. BS GetPropRange
  79. PL  
  80. PT           and 
  81. BS GetPropVisibleRange
  82. PT .
  83. ED
  84.  
  85. |getproprange|
  86. WT GetPropRange {ObjectName}, <LowHorizVarName>, <HighHorizVarName> [,<LowVertVarName>, <HighVertVarName>]
  87. PL This will retrieve a proportional object's
  88. PL upper and lower range limits.
  89. PL
  90. PT SEE ALSO: 
  91. BS SetPropRange
  92. PT , 
  93. BS GetPropPosition
  94. PL 
  95. PT           and 
  96. BS GetPropVisibleRange
  97. PT .
  98. ED
  99.  
  100. |getpropvisiblerange|
  101. WT GetPropVisibleRange {ObjectName}, <DisplayHorizVarName> [,<DisplayVertVarName>]
  102. PL This will retrieve a proportional object's
  103. PL visible size.
  104. PL
  105. PT SEE ALSO: 
  106. BS SetPropVisibleRange
  107. PT , 
  108. BS GetPropRange
  109. PL
  110. PT           and 
  111. BS GetPropPosition
  112. PT .
  113. ED
  114.  
  115. |integerfrom|
  116. WT {Integer}=IntegerFrom({ObjectName})
  117. PL Returns the integer currently held in
  118. PL in the Integer Field {ObjectName}.
  119. PL
  120. PT SEE ALSO: 
  121. BS TextFrom
  122. PT  and 
  123. BS SetInteger
  124. PT .
  125. ED
  126.  
  127. |keypressed|
  128. WT {String}=KeyPressed
  129. PL This returns the key that was pressed
  130. PL when used with a KeyInput object that
  131. PL is looking for ANY key.
  132. PL
  133. PT SEE ALSO: 
  134. BS QualifiersPressed
  135. PT .
  136. ED
  137.  
  138. |moveobject|
  139. WT MoveObject {ObjectName},{X},{Y}
  140. PL Moves an object in the visible window
  141. PL to the coordinates {X},{Y}.
  142. ED
  143.  
  144. |objectattached|
  145. WT {Logical}=ObjectAttached({ObjectName})
  146. PT Returns 
  147. BS True
  148. PL  if the named object is
  149. PL currently attached.
  150. PL
  151. PT SEE ALSO: 
  152. BS DetachObject
  153. PT  and 
  154. BS ReattachObject
  155. PT .
  156. ED
  157.  
  158. |objectname|
  159. WT {String}=ObjectName
  160. PL This returns the name of the currently
  161. PL running object.
  162. ED
  163.  
  164. |objectstate|
  165. WT {Logical}=ObjectState({ObjectName})
  166. PL This indicates if the object is currently
  167. PL selected.  With menus this also indicates
  168. PL if the item's checkmark is checked.
  169. PL
  170. PT SEE ALSO: 
  171. BS SetObjectState
  172. PT .
  173. ED
  174.  
  175. |qualifierspressed|
  176. WT {String}=QualifiersPressed
  177. PL String of words, one for each qualifier
  178. PL pressed in the last keyboard input, or
  179. PL NONE if none.  Qualifiers include:  CONTROL,
  180. PL CAPSLOCK, RIGHTALT, LEFTALT, RIGHTSHIFT,
  181. PL LEFTSHIFT, LEFTAMIGA, RIGHTAMIGA, LEFTMOUSE,
  182. PL MIDDLEMOUSE, and RIGHTMOUSE.
  183. ED
  184.  
  185. |reattachobject|
  186. WT ReattachObject {ObjectName} [,{Arg1} [,up to ten arguments]]
  187. PL This will attach an object that has been
  188. PL detached.  This will do nothing if the
  189. PL object is already attached.
  190. PL
  191. PT SEE ALSO: 
  192. BS DetachObject
  193. PT  and 
  194. BS ObjectAttached
  195. PT .
  196. ED
  197.  
  198. |refreshobject|
  199. WT RefreshObject {ObjectName} ;<- only works on document objects
  200. PL Update the display of a document of list
  201. PL object.  While this normally occurs at the
  202. PL end of each script, this command forces the
  203. PL update to occur during the script.  THIS
  204. PL SHOULD ONLY BE USED WITH DOCUMENT OBJECTS!
  205. ED
  206.  
  207. |setinteger|
  208. WT SetInteger {ObjectName}, {Integer}
  209. PL Sets the value displayed in the Integer
  210. PL Field indicated by {ObjectName} to the
  211. PL given {Integer}.
  212. PL
  213. PT SEE ALSO: 
  214. BS SetText
  215. PT  and 
  216. BS IntegerFrom
  217. PT .
  218. ED
  219.  
  220. |setobjectstate|
  221. WT SetObjectState {ObjectName}, {Logical}
  222. PT Used to deselect or select an Object.  
  223. BS True
  224. PL
  225. PT will select the Object, 
  226. BS False
  227. PL  will deselect
  228. PL the Object.  If the object is a "checkable"
  229. PL menu item or checkmark toggle button, this
  230. PL will set or clear the check mark.
  231. PT SEE ALSO: 
  232. BS ObjectState
  233. PT .
  234. ED
  235.  
  236. |setpropposition|
  237. WT SetPropPosition {ObjectName}, {HorizPos} [,{VertPos}]
  238. PL This will set a proportional object's
  239. PL positional values.
  240. PL
  241. PT SEE ALSO: 
  242. BS GetPropPosition
  243. PT , 
  244. BS SetPropRange
  245. PL  
  246. PT           and 
  247. BS SetPropVisibleRange
  248. PT .
  249. ED
  250.  
  251. |setproprange|
  252. WT SetPropRange {ObjectName}, {LowHoriz}, {HighHoriz} [,{LowVert}, {HighVert}]
  253. PL This will set a proportional object's
  254. PL upper and lower range limits.
  255. PL
  256. PT SEE ALSO: 
  257. BS GetPropRange
  258. PT , 
  259. BS SetPropPosition
  260. PL 
  261. PT           and 
  262. BS SetPropVisibleRange
  263. PT .
  264. ED
  265.  
  266. |setpropvisiblerange|
  267. WT SetPropVisibleRange {ObjectName}, {DisplayHoriz} [,{DisplayVert}]
  268. PL This will set a proportional object's
  269. PL visible size.
  270. PL
  271. PT SEE ALSO: 
  272. BS GetPropVisibleRange
  273. PT , 
  274. BS SetPropRange
  275. PL
  276. PT           and 
  277. BS SetPropPosition
  278. PT .
  279. ED
  280.  
  281. |settext|
  282. WT SetText {ObjectName},{String}
  283. PL Sets the string displayed in the text
  284. PL Field indicated by {ObjectName} to the
  285. PL given {String}.
  286. PL
  287. PT SEE ALSO: 
  288. BS SetInteger
  289. PT  and 
  290. BS TextFrom
  291. PT .
  292. ED
  293.  
  294. |textfrom|
  295. WT {String}=TextFrom({ObjectName})
  296. PL Returns the string currently held in
  297. PL in the Text Field {ObjectName}.
  298. PL
  299. PT SEE ALSO: 
  300. BS IntegerFrom
  301. PT  and 
  302. BS SetText
  303. PT .
  304. ED
  305.